Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add swagger spec #6

Merged
merged 4 commits into from
Dec 27, 2024
Merged

docs: add swagger spec #6

merged 4 commits into from
Dec 27, 2024

Conversation

namhoang1604
Copy link
Contributor

@namhoang1604 namhoang1604 commented Nov 12, 2024

Description

This PR adds Swagger API spec

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

https://github.com/gs-gs/fa-ag-trace/issues/681
https://github.com/gs-gs/fa-ag-trace/issues/870

Mobile & Desktop Screenshots/Recordings

image image

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ“• storybook
  • πŸ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Signed-off-by: Nam Hoang <[email protected]>
Copy link
Contributor

github-actions bot commented Nov 12, 2024

Coverage report

St.❔
Category Percentage Covered / Total
🟒 Statements 94.15% 177/188
🟒 Branches 96.67% 29/30
🟒 Functions 84.62% 22/26
🟒 Lines 94.02% 173/184

Test suite run success

41 tests passing in 10 suites.

Report generated by πŸ§ͺjest coverage report action from 9fc4ff2

@namhoang1604 namhoang1604 marked this pull request as ready for review November 12, 2024 08:59
ldhyen99
ldhyen99 previously approved these changes Nov 12, 2024
Copy link
Collaborator

@ashleythedeveloper ashleythedeveloper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @namhoang1604, if I change the accepted payloads in the request/response of the API, how is this change reflected in the API spec generated? Are we relying on the contributor to know to change the version of the API spec?

README.md Outdated Show resolved Hide resolved
huynguyen-hl
huynguyen-hl previously approved these changes Dec 24, 2024
…into docs/add-swagger-spec

* 'next' of github.com:uncefact/project-identity-resolver:
  chore: implement the Publish Tag workflow (#11)
  docs: implement versioning documentation (#10)
  docs: init documentation site with Docusaurus setup (#9)
  feat: implement AWS S3 storage adapter (#8)
@namhoang1604 namhoang1604 dismissed stale reviews from huynguyen-hl and ldhyen99 via 0200149 December 26, 2024 02:58
@namhoang1604 namhoang1604 merged commit 48bd8aa into next Dec 27, 2024
3 checks passed
@namhoang1604 namhoang1604 deleted the docs/add-swagger-spec branch December 27, 2024 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants